/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

#import "OFXAssetClassPortion.h"
#import "OFXSecurity.h"

typedef enum {
  OPTION_PUT,
  OPTION_CALL
} OFXOptionType;

@interface OFXOption : OFXSecurity {
  NSString*    assetClass;
  NSDate*      expirationDate;
  NSString*    financialInstitutionAssetClass;
  NSString*    optionType;
  NSNumber*    sharesPerContract;
  NSNumber*    strikePrice;
  OFXSecurity* security;
}

/**
 * @property assetClass
 * @brief Asset class of option.
 *
 * One of:
 * - DOMESTICBOND
 * - INTLBOND
 * - LARGESTOCK
 * - SMALLSTOCK
 * - INTLSTOCK
 * - MONEYMRKT
 * - OTHER
 */
@property(retain) NSString*    assetClass;

/**
 * @property expirationDate
 * @brief Date option expires
 */
@property(retain) NSDate*      expirationDate;

/**
 * @property financialInstitutionAssetClass
 * @brief Text string containing an financial institution defined asset class
 */
@property(retain) NSString*    financialInstitutionAssetClass;

/**
 * @property optionType
 * @brief Option type: PUT or CALL
 */
@property(retain) NSString*    optionType;

/**
 * @property sharesPerContract
 * @brief Number of shares per contract
 */
@property(retain) NSNumber*    sharesPerContract;

/**
 * @property strikePrice
 * @brief Strike price (unitprice)
 */
@property(retain) NSNumber*    strikePrice;

/**
 * @property security
 * @brief Underlying security information
 */
@property(retain) OFXSecurity* security;

@end
